Esx Hosts AlternativeImageInfo

Esx Hosts AlternativeImageInfo
Esx Hosts AlternativeImageInfo

The Esx Hosts AlternativeImageInfo schema contains properties that describes an alternative image for the desired software specification.

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "base_image": {
        "version": "string",
        "display_name": "string",
        "display_version": "string",
        "release_date": "string"
    },
    "add_on": {
        "name": "string",
        "version": "string",
        "display_name": "string",
        "vendor": "string",
        "display_version": "string"
    },
    "components": {
        "components": {
            "version": "string",
            "display_name": "string",
            "display_version": "string",
            "vendor": "string"
        }
    },
    "solutions": {
        "solutions": {
            "version": "string",
            "display_name": "string",
            "components": {
                "components": {
                    "version": "string",
                    "display_name": "string",
                    "display_version": "string",
                    "vendor": "string"
                }
            }
        }
    },
    "hardware_support": {
        "packages": {
            "packages": {
                "pkg": "string",
                "version": "string"
            }
        }
    },
    "removed_components": {
        "removed_components": {
            "version": "string",
            "display_name": "string",
            "display_version": "string",
            "vendor": "string"
        }
    },
    "display_name": "string",
    "selection_criteria": {
        "selection_type": "string",
        "host_uuids": [
            "string"
        ],
        "host_hardware_spec": {
            "vendor": "string",
            "models": [
                "string"
            ],
            "families": [
                "string"
            ],
            "oem_strings": [
                "string"
            ]
        }
    }
}
base_image
Required

Base image of the ESX.

This property was added in vSphere API 9.0.0.0.

add_on
Optional

OEM customization on top of given base-image. The components in this customization override the components in the base base-image.

This property was added in vSphere API 9.0.0.0.

If missing or null, no OEM customization exists.

object
components
Required

Map of components in an ESX image. The key is the component name and value is the information about specific version of the component.

This property was added in vSphere API 9.0.0.0.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.hosts.component. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.hosts.component.

object
solutions
Required

Map of software solutions in an ESX image. The key is the solution name and value is the specification detailing components registered by that solution.

This property was added in vSphere API 9.0.0.0.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.hosts.solution. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.hosts.solution.

hardware_support
Optional

Information about the Hardware Support Packages (HSP) configured.

This property was added in vSphere API 9.0.0.0.

If missing or null, no Hardware Support Package (HSP) info exists.

object
removed_components
Optional

Information about the components to be removed in the software specification.

This property was added in vSphere API 9.0.0.0.

If missing or null, no removed component info exists.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.hosts.component. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.hosts.component.

string
display_name
Required

Display name of the Alternative Image. Supported encoding is UTF-8.

This property was added in vSphere API 9.0.0.0.

selection_criteria
Required

Selection criteria used to select the alternative image for 1 or more hosts

This property was added in vSphere API 9.0.0.0.